-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Removing Pattern from ManagedInstance to avoid incident #25295
Removing Pattern from ManagedInstance to avoid incident #25295
Conversation
…fixing prettier check
… not be present and will cause issues in downstream client generation
…o release-sql-Microsoft.Sql-2023-02-01-preview
Hi, @jeremyfrosti! Thank you for your pull request. To help get your PR merged: Generated ApiView comment added to this PR. You can use ApiView to show API versions diff. |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
ManagedInstances.json | 2023-02-01-preview(a06ff8e) | 2021-11-01(main) |
ManagedInstances.json | 2023-02-01-preview(a06ff8e) | 2022-11-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Rule | Message |
---|---|
1019 - RemovedEnumValue |
The new version is removing enum value(s) 'Creating, Deleting, Updating, Unknown, Accepted, Deleted, Unrecognized, Running, NotSpecified, Registering, TimedOut' from the old version. New: Microsoft.Sql/preview/2023-02-01-preview/ManagedInstances.json#L952:9 Old: Microsoft.Sql/stable/2021-11-01/ManagedInstances.json#L806:9 |
1048 - AddedXmsEnum |
The new version adds a x-ms-enum extension. New: Microsoft.Sql/preview/2023-02-01-preview/ManagedInstances.json#L952:9 Old: Microsoft.Sql/stable/2021-11-01/ManagedInstances.json#L806:9 |
️❌
LintDiff: 6 Errors, 0 Warnings failed [Detail]
compared tags (via openapi-validator v2.1.4) | new version | base version |
---|---|---|
package-preview-2023-02 | package-preview-2023-02(a06ff8e) | package-preview-2023-02(release-sql-Microsoft.Sql-2023-02-01-preview) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
ResourceNameRestriction |
The resource name parameter 'managedInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2023-02-01-preview/ManagedInstances.json#L170 |
RPC-Uri-V1-05 |
ResourceNameRestriction |
The resource name parameter 'managedInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2023-02-01-preview/ManagedInstances.json#L434 |
RPC-Uri-V1-05 |
ResourceNameRestriction |
The resource name parameter 'managedInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2023-02-01-preview/ManagedInstances.json#L476 |
RPC-Uri-V1-05 |
ResourceNameRestriction |
The resource name parameter 'managedInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2023-02-01-preview/ManagedInstances.json#L530 |
RPC-Uri-V1-05 |
ResourceNameRestriction |
The resource name parameter 'managedInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2023-02-01-preview/ManagedInstances.json#L576 |
RPC-Uri-V1-05 |
ResourceNameRestriction |
The resource name parameter 'managedInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2023-02-01-preview/ManagedInstances.json#L622 |
RPC-Uri-V1-05 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
Azure Pipelines successfully started running 1 pipeline(s). |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
Please address or respond to feedback from the ARM API reviewer. |
Hi @jeremyfrosti! The automation detected breaking changes in this pull request. As a result, it added the
|
Hi @jeremyfrosti! Your PR has some issues. Please fix the CI issues, if present, in following order:
If you need further help, please reach out on the Teams channel aka.ms/azsdk/support/specreview-channel. |
Based on historical PRs for this swagger, I am going to approve this. See this comment for last approved merge Which refers to another two PRS:
I'll let @konrad-jamrozik speak to LintDiff approval, but based on the history here we should probably just get out of the way. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
We are seeking LintDiff approval based on the context in the above comment by scbedd. The context:
|
Next Steps to Merge |
/pr RequestMerge |
177e266
into
Azure:release-sql-Microsoft.Sql-2023-02-01-preview
* Adds base for updating Microsoft.Sql from version preview/2022-11-01-preview to version 2023-02-01-preview * Updates readme * Updates API version in new specs and examples * add mi refresh API (#24093) * add mi refresh API * remove stray character * add examples * fix lro error * fix lro error only in example * fixing prettier issue * Test commit - adding error schema * Test2 * Test - changing error type * Revert "Test - changing error type" This reverts commit 84fff94. * Reverting 3 test commits * Test - adding commong error type reference * fix type format errors --------- Co-authored-by: Stefan Krivokapic <[email protected]> * Adding changes from main to release branch. PRs 24175 and 24185 (#24221) * Enable multiple partner servers and failover of read-only endpoint for SQL DB Failover Group in version 2023-02-01-preview. (#24132) * Added the swagger spec and example json files for failvoer group API update in V2023-020-1 * Corrected the FailoverGroupGet.json example * Updated the auto-generated FailoverGroups.json Fixed FailoverGroups.json swagger arm-id attribute for databases field * Added the missing headers field manually * Fix FailoverGroups.json --------- Co-authored-by: Sharan Singh <[email protected]> * Changes to Location Capabilities (#24209) * Loc cap changes * removing changes not related to my changes in dsmain * DAG API 2023-02-01 (#24108) * add new dag api version * Update swagger * Update swagger * patch resource * make replicationMode writable * Add FreeLimitExhaustion Capability in 2023-02-01-preview API (#24224) * Add FreeLimitExhaustion Capability in 2023-02-01-preview API * Change property from name to exhaustionBehaviorType * generate swagger for LocationCapabilites (#24290) * inital commit for LTR Policy Immutability (#24347) * inital commit for immutable ltr backups (#24349) * Update Servers swagger files with adding property "IsIPv6Enabled" (#24305) * Update swagger files for Server API * Add v5 tag for Servers * Restore none for minimal TLS version * Add auto rotation param to databases api (#24339) * Add auto rotation param to databases api * add armid * Adding IsFreemium and CreateTime to Get MI API (#24239) * Updated the examples for LTR Policies and LTR Backups (#24821) * Updated the examples for LTR Policies and LTR Backups * Not sure why makeBackupsImmutable got deleted * updating swagger files for enum name changes (#24742) * Carrying over minor changes for the 2023-02-01-preview release (#25177) * Carrying over minor changes for the 2023-02-01-preview release * Reverting example files that didn't have DsMainDev side changes, and fixing prettier check * Fixes for LTR examples with model validation and prettier check for ServerDelete * Reverting LTR changes * Adding arm-id to serversjson * swagger changes for adding new parameter in dc telemetry (#24834) * testing push * reverting push * swagger files for DC add parameter change * delete added file * modified swagger files without Venkat's change * modified swagger files * changed modelAsString to true * add example files * add example files * fix mismatch * Removing Pattern from ManagedInstance to avoid incident (#25295) * Carrying over minor changes for the 2023-02-01-preview release * Reverting example files that didn't have DsMainDev side changes, and fixing prettier check * Fixes for LTR examples with model validation and prettier check for ServerDelete * Reverting LTR changes * Adding arm-id to serversjson * Removing the Pattern property from ManagedInstances.json as it should not be present and will cause issues in downstream client generation --------- Co-authored-by: guptanitish-ms <[email protected]> Co-authored-by: Stefan Krivokapic <[email protected]> Co-authored-by: lobashh <[email protected]> Co-authored-by: Sharan Singh <[email protected]> Co-authored-by: Aleksand4rZivanovic <[email protected]> Co-authored-by: a-lazarlazic <[email protected]> Co-authored-by: mykolian <[email protected]> Co-authored-by: Srna Nikolic <[email protected]> Co-authored-by: rebeccaxu-ms <[email protected]> Co-authored-by: LeiWang3 <[email protected]> Co-authored-by: viparek <[email protected]> Co-authored-by: Nikola Mirkovic <[email protected]> Co-authored-by: pmahanandire <[email protected]> Co-authored-by: nidhigupta <[email protected]>
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] public repo review queue, private repo review queue
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequested
is removed from your PR. This should cause the label
WaitForARMFeedback
to be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue
If you need further help with anything, see
Getting help
section below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReview
label.Getting help
and https://aka.ms/ci-fix.